StringScanner.SkipOverWhitespace Function

Syntax

Chars_Skipped as N = SkipOverWhitespace as n()

Arguments

Chars_Skipped: The number of characters the offset has been moved.

Description

Skip over a sequence of whitespace characters . Returns number of characters skipped.

Discussion

The <StringScanner>.SkipOverWhitespace() function moves the offset to the next character that is not a whitespace character and returns the number of characters that the offset has moved. The offset does not move if it is already pointing to a whitespace character. The function treats the following characters as white space.

Character: ASCII Value
space: chr(32)
tab: chr(9)
carriage return: chr(10)
line feed: chr(13)

Example

dim scanner as P
dim txt as C
txt = <<%text%
This is wonderful prose written
by a technical writer of note.
%text%
scanner = stringscanner.create(txt)
scanner.skipover(4)
? scanner.SkipOverWhitespace()
= 1
? scanner.GetToOffset()
= "This "
? scanner.GetRemainder()
= is wonderful prose written
by a technical writer of note.